-
Notifications
You must be signed in to change notification settings - Fork 2.6k
feat(dx): streamline extension installation and documentation #4284
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
f41873d to
a0dcc96
Compare
daniel-lxs
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @devxpain, Thank you for your contribution!
I left a couple of questions that are worth checking out before we approve your PR.
Let me know what you think!
daniel-lxs
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @devxpain, I left a suggestion to make the script a bit more robust, let me know what you think.
|
Hi @daniel-lxs, I’ve updated it based on your code and added the |
|
@devxpain Let me know if you have any questions. |
- Introduce `pnpm install:vsix` command for automated VSIX installation.
- This new command handles uninstalling existing versions, building the latest VSIX, and installing it directly into the specified editor.
- Add options (`-y` for non-interactive, `--editor=<command>` to specify editor like `cursor` or `code-insiders`) to the `install:vsix` script.
- Update `README.md` to provide clearer, segmented instructions for running the extension:
- Development Mode (F5) with clarified hot reload behavior.
- Automated VSIX Installation using the new `pnpm install:vsix` command.
- Manual VSIX Installation steps.
@daniel-lxs I’ve already applied your patch—thanks for the fixes! |
daniel-lxs
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you @devxpain!
Related GitHub Issue
Discussions: 4238
Description
This commit introduces a new
pnpm install:vsixcommand and updates theREADME.mdto improve the developer experience for installing and testing the VS Code extension.pnpm install:vsixcommand: Automates the process of uninstalling the current extension, building the latest VSIX package, and installing it. This simplifies iterative development and testing.README.md: The 'Run the extension' section has been significantly expanded and clarified, now detailing:pnpm install:vsixcommand.scripts/install-vsix.js: Provides the logic for the automated installation process.code --reload-windownot always working reliably, potentially requiring a manual VS Code restart.Test Procedure
pnpm install:vsixType of Change
srcor test files.Pre-Submission Checklist
npm run lint).console.log) has been removed.npm test).mainbranch.npm run changesetif this PR includes user-facing changes or dependency updates.Documentation Updates
Get in Touch
Important
Adds
pnpm install:vsixcommand and updates documentation to streamline VSIX package installation for VS Code extension development.pnpm install:vsixcommand inpackage.jsonto automate VSIX package installation.scripts/install-vsix.jsto handle uninstalling, building, and installing the VSIX package.README.mdto include instructions for usingpnpm install:vsixand manual VSIX installation steps.This description was created by
for 4f0c5225f7f5c570ece1e82724e8850945ebf622. You can customize this summary. It will automatically update as commits are pushed.